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
One or more unique identifiers of line item data in an external source.
Root Schema : List<ApiEntityExternallySourcedCommitmentLineItem>
Type:
arrayTitle:
Show Source
List<ApiEntityExternallySourcedCommitmentLineItem>Nested Schema : ApiEntityExternallySourcedCommitmentLineItem
Type:
Show Source
object-
abbreviation(optional):
string
The abbreviated name of a cost category.
-
cbsCode(optional):
string
The user-specified identifier of a CBS.
-
cbsSourceId(optional):
string
The unique identifier of CBS data in an external source.
-
commitmentCode(optional):
string
The user-specified identifier of a commitment.
-
commitmentId:
integer(int64)
The unique identifier of the commitment.
-
commitmentLineItemCost(optional):
object ApiEntityCommitmentLineItemCost
-
commitmentSourceId(optional):
string
The unique identifier of commitment data in an external source.
-
costCategoryId(optional):
integer(int64)
The system-generated identifier of a cost category.
-
costCategoryName(optional):
string
The name of a cost category.
-
costSheetItem(optional):
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(optional):
string
-
currencyId(optional):
integer(int64)
The unique identifier of a currency.
-
description(optional):
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(optional):
integer(int64)
The unique identifier for the line item.
-
lineItemType:
string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]The type of a line item. -
link(optional):
string(url)
Read Only:
true -
name:
string
Allowed Values:
[ "Length[0-255]" ]The name of a line item. -
pegRate(optional):
number
Read Only:
trueThe peg rate of a line item. -
projectCode(optional):
string
The user-specified identifier of a project.
-
quantity(optional):
object Quantity
-
sourceId(optional):
string
The unique identifier of a commitment line item in an external source.
-
unitsOfMeasureCode(optional):
string
The user-specified identifier of a project.
-
unitsOfMeasureId(optional):
integer(int64)
The unique identifier for the unit of measure.
-
updateDate(optional):
string(date-time)
Read Only:
trueDate when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceCode(optional):
string
The user-specified identifier of a workspace.
Nested Schema : ApiEntityCommitmentLineItemCost
Type:
Show Source
object-
lineItemId(optional):
integer(int64)
-
link(optional):
string(url)
Read Only:
true -
total(optional):
object Cost
-
totalCommitment(optional):
object Cost
-
totalContract(optional):
object Cost
-
totalLineItem(optional):
object Cost
-
totalProject(optional):
object Cost
-
unitPrice(optional):
object Cost
-
unitPriceCommitment(optional):
object Cost
-
unitPriceContract(optional):
object Cost
-
unitPriceLineItem(optional):
object Cost
-
unitPriceProject(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
trueDate when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : Quantity
Type:
objectNested Schema : Cost
Type:
objectResponse
Supported Media Types
- application/json
207 Response
The object was sucessfully integrated.
Nested Schema : ApiEntityERPSyncApiResponse
Type:
Show Source
object-
link(optional):
string(url)
Read Only:
true -
message(optional):
string
-
primaryKey(optional):
integer(int64)
-
primaryKeyName(optional):
string
-
primaryKeyValue(optional):
integer(int64)
-
sourceId(optional):
string
-
statusCode(optional):
integer(int32)
-
uniqueName(optional):
string
-
updateDate(optional):
string(date-time)
Read Only:
trueDate when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
400 Response
Invalid Input.