Prime Projects Open Integration API

Batch Integrate Budget Items with an External Data Source

post

/primeapi/restapi/budgetItem/syncBatch

Send a request to this endpoint to create or update one or more integrated budget items. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.

Request

Supported Media Types

application/json

The unique identifier of budget item data in an external source.S

Root Schema : List<ApiEntityExternallySourcedBudgetItem>

Type: array

Title: List<ApiEntityExternallySourcedBudgetItem>

Show Source

[0]: object ApiEntityExternallySourcedBudgetItem

{
    "title":"List<ApiEntityExternallySourcedBudgetItem>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityExternallySourcedBudgetItem"
    }
}

Nested Schema : ApiEntityExternallySourcedBudgetItem

Type: object

Show Source

abbreviation: string

The abbreviated name of a cost category.
budgetChangeId: integer(int64)

Indicates whether the budget item originated in a budget change.
budgetHours: object Hour
budgetItemConfiguredFields: object ApiEntityBudgetItemConfiguredFields
budgetItemCost: object ApiEntityBudgetItemCost
budgetItemId: integer(int64)

The system-generated identifier of a budget item.
cbsCode: string
The object has a code that matches the value of the {code} path parameter.

costCategoryId: integer(int64)

The type of cost associated with the budget item.

costCategoryName: string

The object has a code that matches the value of the {code} path parameter.

the cost category assigned to this budget item.

costSheetItemId: integer(int64)

The name of the CBS Code.

itemCode: string

The unique identifier of the project budget item.

itemName: string

The name of the budget item.

itemSuffix: integer(int64)

The suffix of a budget item code.

link: string(uri)

Read Only: true

productionRate: object Hour

projectBudgetId: integer(int64)

The system-generated identifier of a project budget.

projectCode: string

The object has a code that matches the value of the {code} path parameter.

the project associated with this budget item.

quantity: number(double)

The number of each budget item needed to complete the work.

sourceId: string

The unique identifier of budget item data in an external source.

Example: coarse

unitsOfMeasureId: integer(int64)

The Unit of Measure used for the budget item.

updateDate: string(date-time)

Read Only: true

The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.

workspaceCode: string

The user-specified identifier of a workspace.

{
    "type":"object",
    "required":[
        "budgetItemId",
        "costSheetItemId",
        "itemCode",
        "itemName",
        "projectBudgetId"
    ],
    "properties":{
        "cbsCode":{
            "type":"string",
            "description":"<li>The object has a code that matches the value of the {code} path parameter.</li> the CBS associated with this budget item."
        },
        "unitsOfMeasureId":{
            "type":"integer",
            "format":"int64",
            "description":"The Unit of Measure used for the budget item."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.",
            "readOnly":true
        },
        "budgetItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a budget item."
        },
        "budgetItemCost":{
            "description":"Contains Budget Item cost related fields.",
            "$ref":"#/definitions/ApiEntityBudgetItemCost"
        },
        "budgetItemConfiguredFields":{
            "description":"<li>The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.</li>",
            "$ref":"#/definitions/ApiEntityBudgetItemConfiguredFields"
        },
        "budgetChangeId":{
            "type":"integer",
            "format":"int64",
            "description":"Indicates whether the budget item originated in a budget change."
        },
        "budgetHours":{
            "description":"The number of hours needed to complete the budget item. Calculated as Production Rate multiplied by Quantity.",
            "$ref":"#/definitions/Hour"
        },
        "costCategoryName":{
            "type":"string",
            "description":"<li>The object has a code that matches the value of the {code} path parameter.</li> the cost category assigned to this budget item."
        },
        "sourceId":{
            "type":"string",
            "example":"coarse",
            "description":"The unique identifier of budget item data in an external source."
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The suffix of a budget item code."
        },
        "quantity":{
            "type":"number",
            "format":"double",
            "description":"The number of each budget item needed to complete the work."
        },
        "costCategoryId":{
            "type":"integer",
            "format":"int64",
            "description":"The type of cost associated with the budget item."
        },
        "costSheetItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The name of the CBS Code."
        },
        "itemCode":{
            "type":"string",
            "description":"The unique identifier of the project budget item."
        },
        "link":{
            "type":"string",
            "format":"uri",
            "readOnly":true
        },
        "productionRate":{
            "description":"The number of hours per unit of measure needed to complete the budget item.",
            "$ref":"#/definitions/Hour"
        },
        "projectCode":{
            "type":"string",
            "description":"<li>The object has a code that matches the value of the {code} path parameter.</li> the project associated with this budget item."
        },
        "abbreviation":{
            "type":"string",
            "description":"The abbreviated name of a cost category."
        },
        "itemName":{
            "type":"string",
            "description":"The name of the budget item."
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace."
        },
        "projectBudgetId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a project budget."
        }
    }
}

Nested Schema : Hour

Type: object

Show Source

bigDecimal: number
double: number(double)

{
    "type":"object",
    "properties":{
        "bigDecimal":{
            "type":"number"
        },
        "double":{
            "type":"number",
            "format":"double"
        }
    }
}

Nested Schema : ApiEntityBudgetItemConfiguredFields

Type: object

Show Source

budgetItemId: integer(int64)

The system-generated identifier of a budget item.
costFlexMap: object costFlexMap

Additional Properties Allowed: additionalProperties

An object containing cost fields in the form of key-value pairs.
link: string(uri)

Read Only: true
otherFlexMap: object otherFlexMap

Additional Properties Allowed: additionalProperties

An object containing non-cost, non-text fields in the form of key-value pairs.
textFlexMap: object textFlexMap

Additional Properties Allowed: additionalProperties

An object containing text fields in the form of key-value pairs.
updateDate: string(date-time)

Read Only: true

The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"uri",
            "readOnly":true
        },
        "budgetItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a budget item."
        },
        "otherFlexMap":{
            "type":"object",
            "description":"An object containing non-cost, non-text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "costFlexMap":{
            "type":"object",
            "description":"An object containing cost fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"An object containing text fields in the form of key-value pairs.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.",
            "readOnly":true
        }
    }
}

Nested Schema : ApiEntityBudgetItemCost

Type: object

Show Source

budgetItemId: integer(int64)

The system-generated identifier of a budget item.
currentCost: object Cost
currentCostProject: object Cost
currentCostWorkspace1: object Cost
currentCostWorkspace2: object Cost
currentCostWorkspace3: object Cost
laborRate: object Cost
laborRateProject: object Cost
laborRateWorkspace1: object Cost
laborRateWorkspace2: object Cost
laborRateWorkspace3: object Cost
link: string(uri)

Read Only: true
originalCost: object Cost
originalCostProject: object Cost
originalCostWorkspace1: object Cost
originalCostWorkspace2: object Cost
originalCostWorkspace3: object Cost
unitRate: object Cost
unitRateProject: object Cost
unitRateWorkspace1: object Cost
unitRateWorkspace2: object Cost
unitRateWorkspace3: object Cost
updateDate: string(date-time)

Read Only: true

The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.

{
    "type":"object",
    "required":[
        "budgetItemId"
    ],
    "properties":{
        "originalCostWorkspace1":{
            "description":"The original cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.",
            "readOnly":true
        },
        "budgetItemId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a budget item."
        },
        "originalCostWorkspace3":{
            "description":"The original cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "laborRateProject":{
            "description":"The labor rate cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "unitRateWorkspace2":{
            "description":"The unit rate cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "currentCostWorkspace3":{
            "description":"The current cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "originalCost":{
            "description":"The original cost of the budget line item.",
            "$ref":"#/definitions/Cost"
        },
        "unitRateWorkspace3":{
            "description":"The unit rate cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "laborRateWorkspace1":{
            "description":"The labor rate cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "currentCostProject":{
            "description":"The current cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "unitRateProject":{
            "description":"The unit rate cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "originalCostWorkspace2":{
            "description":"The original cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "laborRateWorkspace2":{
            "description":"The labor rate cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "unitRateWorkspace1":{
            "description":"The unit rate cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "link":{
            "type":"string",
            "format":"uri",
            "readOnly":true
        },
        "laborRateWorkspace3":{
            "description":"The labor rate cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "originalCostProject":{
            "description":"The original cost of a project.",
            "$ref":"#/definitions/Cost"
        },
        "currentCost":{
            "description":"The current cost of the budget line item.",
            "$ref":"#/definitions/Cost"
        },
        "currentCostWorkspace2":{
            "description":"The current cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "laborRate":{
            "description":"The cost per labor hour of the budget line item.",
            "$ref":"#/definitions/Cost"
        },
        "currentCostWorkspace1":{
            "description":"The current cost of a workspace.",
            "$ref":"#/definitions/Cost"
        },
        "unitRate":{
            "description":"The cost per Unit of Measure for the budget line item.",
            "$ref":"#/definitions/Cost"
        }
    }
}

Nested Schema : costFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"An object containing cost fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

An object containing cost fields in the form of key-value pairs.

Nested Schema : otherFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"An object containing non-cost, non-text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

An object containing non-cost, non-text fields in the form of key-value pairs.

Nested Schema : textFlexMap

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "type":"object",
    "description":"An object containing text fields in the form of key-value pairs.",
    "additionalProperties":{
        "type":"object"
    }
}

An object containing text fields in the form of key-value pairs.

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

Nested Schema : Cost

Type: object

Response

Supported Media Types

application/json

207 Response

Successful Sync Operation.

Root Schema : schema

Type: array

Show Source

[0]: object ApiEntityERPSyncApiResponse

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityERPSyncApiResponse"
    }
}

Nested Schema : ApiEntityERPSyncApiResponse

Type: object

Show Source

link: string(uri)

Read Only: true
message: string
primaryKey: integer(int64)
primaryKeyName: string
primaryKeyValue: integer(int64)
sourceId: string
statusCode: integer(int32)
uniqueName: string
updateDate: string(date-time)

Read Only: true

The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "primaryKeyValue":{
            "type":"integer",
            "format":"int64"
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.",
            "readOnly":true
        },
        "sourceId":{
            "type":"string"
        },
        "statusCode":{
            "type":"integer",
            "format":"int32"
        },
        "link":{
            "type":"string",
            "format":"uri",
            "readOnly":true
        },
        "uniqueName":{
            "type":"string"
        },
        "primaryKeyName":{
            "type":"string"
        },
        "primaryKey":{
            "type":"integer",
            "format":"int64"
        }
    }
}

400 Response

Invalid Input.