Batch Integrate Commitment Line Items with an External Data Source
post
/primeapi/restapi/commitmentLineItem/syncBatch
Send a request to this endpoint to create or update one or more integrated commitment line 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 line item data in an external source.S
Root Schema : List<ApiEntityExternallySourcedCommitmentLineItem>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedCommitmentLineItem>
Nested Schema : ApiEntityExternallySourcedCommitmentLineItem
Type:
Show Source
object
-
abbreviation:
string
The abbreviated name of a cost category.
-
cbsCode:
string
The user-specified identifier of a CBS.
-
cbsSourceId:
string
The unique identifier of CBS data in an external source.
-
commitmentCode:
string
The user-specified identifier of a commitment.
-
commitmentId:
integer(int64)
The unique identifier of the commitment.
-
commitmentLineItemCost:
object ApiEntityCommitmentLineItemCost
-
commitmentSourceId:
string
The unique identifier of commitment data in an external source.
-
costCategoryId:
integer(int64)
The system-generated identifier of a cost category.
-
costCategoryName:
string
The name of a cost category.
-
costSheetItem:
integer(int64)
The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
-
currencyCode:
string
-
currencyId:
integer(int64)
The unique identifier of a currency.
-
description:
string
Allowed Values:
[ "Length[0-4000]" ]
Additional details for the commitment. -
itemCode:
string
Allowed Values:
[ "Length[0-60]" ]
The user-specified identifier of a line item. -
lineItemId:
integer(int64)
The unique identifier for the line item.
-
lineItemType:
string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
The type of a line item. -
link:
string(uri)
Read Only:
true
-
name:
string
Allowed Values:
[ "Length[0-255]" ]
The name of a line item. -
pegRate:
number
The peg rate of a line item.
-
projectCode:
string
The user-specified identifier of a project.
-
quantity:
object Quantity
-
sourceId:
string
The unique identifier of a commitment line item in an external source.Example:
coarse
-
unitsOfMeasureCode:
string
The user-specified identifier of a project.
-
unitsOfMeasureId:
integer(int64)
The unique identifier for the unit of measure.
-
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.
Nested Schema : ApiEntityCommitmentLineItemCost
Type:
Show Source
object
-
lineItemId:
integer(int64)
-
link:
string(uri)
Read Only:
true
-
total:
object Cost
-
totalCommitment:
object Cost
-
totalContract:
object Cost
-
totalLineItem:
object Cost
-
totalProject:
object Cost
-
unitPrice:
object Cost
-
unitPriceCommitment:
object Cost
-
unitPriceContract:
object Cost
-
unitPriceLineItem:
object Cost
-
unitPriceProject:
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.
Nested Schema : Quantity
Type:
object
Nested Schema : Cost
Type:
object
Response
Supported Media Types
- application/json
207 Response
Successful Sync Operation.
Nested Schema : ApiEntityERPSyncApiResponse
Type:
Show Source
object
-
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.
400 Response
Invalid Input.