Batch Integrate Change Order Line Items with an External Data Source
post
/primeapi/restapi/changeOrderLineItem/syncBatch
Send a request to this endpoint to create or update one or more integrated change order 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<ApiEntityExternallySourcedChangeOrderLineItem>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedChangeOrderLineItem>
Nested Schema : ApiEntityExternallySourcedChangeOrderLineItem
Type:
Show Source
object
-
abbreviation(optional):
string
The abbreviated name of a cost category.
-
associatedAgreementCode(optional):
string
The user-specified identifier of an agreement.
-
cbsCode(optional):
string
The user-specified identifier of a CBS.
-
cbsSourceId(optional):
string
The unique identifier of CBS data in an external source.
-
changeOrderCode(optional):
string
The user-specified identifier of a change order
-
changeOrderCollectedCode(optional):
string
Read Only:
true
The user-specified identifier of collected change order line items. -
changeOrderCollectedId(optional):
integer(int64)
Read Only:
true
The system-generated identifier of a change order. -
changeOrderId:
integer(int64)
The change order associated with the line item.
-
changeOrderLineItemCost(optional):
object ApiEntityChangeOrderLineItemCost
-
changeOrderSourceId(optional):
string
The unique identifier of change order data in an external source.
-
changeOrderType(optional):
string
Allowed Values:
[ "CONTRACT", "COMMITMENT" ]
The type of a change order. -
collectedFromLineItemCode(optional):
string
Read Only:
true
The user-specified identifier of a line item. -
collectedFromLineItemId(optional):
integer(int64)
The system-generated identifier of a change order line item.
-
costCategoryId(optional):
integer(int64)
The type of cost represented by the line item.
-
costCategoryName(optional):
string
The name of a cost category.
-
costSheetItemId(optional):
integer(int64)
The cost breakdown structure associated with the line item.
-
currencyCode(optional):
string
The user-specified identifier of a currency.
-
currencyId(optional):
integer(int64)
The currency in which the change order line item is written.
-
description(optional):
string
A brief explanation of the change order line item.
-
fixedExchangeRate(optional):
number
Read Only:
true
The rate of exchange between the currency of the change order line item and the base currency, if the currencies are different. If the currencies are the same, this field is disabled. -
itemCode:
string
The unique identifier for the change order line item.
-
itemSuffix(optional):
integer(int64)
The suffix of a line item code.
-
lineItemId(optional):
integer(int64)
The system-generated identifier of a change order line item.
-
lineItemType:
string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
Specifies how the total cost of the line item is calculated. -
link(optional):
string(url)
Read Only:
true
-
name:
string
The name of the change order line item.
-
projectCode(optional):
string
The user-specified identifier of a project.
-
quantity(optional):
object Quantity
-
sourceId(optional):
string
Change order data from an external source.
-
unitsOfMeasureCode(optional):
string
The user-specified identifier of a project.
-
unitsOfMeasureId(optional):
integer(int64)
The units in which the line item is measured.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date 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 : ApiEntityChangeOrderLineItemCost
Type:
Show Source
object
-
lineItemId(optional):
integer(int64)
The system-generated identifier of a change order line item.
-
link(optional):
string(url)
Read Only:
true
-
total(optional):
object Cost
-
totalAssociatedAgreement(optional):
object Cost
-
totalCommitment(optional):
object Cost
-
totalContract(optional):
object Cost
-
totalLineItem(optional):
object Cost
-
totalProject(optional):
object Cost
-
totalWorkspace1(optional):
object Cost
-
totalWorkspace2(optional):
object Cost
-
totalWorkspace3(optional):
object Cost
-
unitPrice(optional):
object Cost
-
unitPriceAssociatedAgreement(optional):
object Cost
-
unitPriceCommitment(optional):
object Cost
-
unitPriceContract(optional):
object Cost
-
unitPriceLineItem(optional):
object Cost
-
unitPriceProject(optional):
object Cost
-
unitPriceWorkspace1(optional):
object Cost
-
unitPriceWorkspace2(optional):
object Cost
-
unitPriceWorkspace3(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
true
Date 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:
object
Nested Schema : Cost
Type:
object
Response
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:
true
Date 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.