Batch Integrate Project Actuals Line Items with an External Data Source
post
/primeapi/restapi/projectActualsLineItem/syncBatch
Send a request to this endpoint to create or update an integrated project actuals 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<ApiEntityExternallySourcedProjectActualsLineItem>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedProjectActualsLineItem>
Nested Schema : ApiEntityExternallySourcedProjectActualsLineItem
Type:
Show Source
object
-
cbsCode:
string
The user-specified identifier of a CBS.
-
cbsCodeId:
integer(int64)
The CBS code assigned to the actual line item.
-
cbsCodeSourceId:
string
The unique identifier of CBS data in an external source.
-
costCategoryAbbrevation:
string
The abbreviated name of a cost category.
-
costCategoryId:
integer(int64)
The type of cost associated with the actual line item.
-
costCategoryName:
string
The category of a CBS.
-
hours:
object Hour
-
itemCode:
string
Allowed Values:
[ "Length[1-60]" ]
The unique identifier for an actual line item. -
itemSuffix:
integer(int64)
Auto numbering suffix of a project actuals line item code.
-
lineItemId:
integer(int64)
The unique identifier of a project actuals line item.
-
lineItemType:
string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
The type assigned to an actual line item. -
link:
string(uri)
Read Only:
true
-
name:
string
Allowed Values:
[ "Length[1-255]" ]
The name of the actual line item. -
projectActualsCode:
string
The user-specified identifier of a project actual.
-
projectActualsId:
integer(int64)
The unique identifier for the actual.
-
projectActualsLineItemCost:
object ApiEntityProjectActualsLineItemCost
-
projectActualsSourceId:
string
The unique identifier of project actual data in an external source.
-
projectCode:
string
The user-specified identifier of a project.
-
quantity:
object Quantity
-
sourceId:
string
The unique identifier of project actual line item data in an external source.Example:
coarse
-
unitOfMeasureId:
integer(int64)
The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.
-
unitOfMeasureValue:
string
The value of a 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 : ApiEntityProjectActualsLineItemCost
Type:
Show Source
object
-
lineItemId:
integer(int64)
The system-generated identifier of a project actual line item.
-
link:
string(uri)
Read Only:
true
-
projectActualsLineItem:
object ApiEntityProjectActualsLineItem
-
total:
object Cost
-
totalProject:
object Cost
-
totalProjectActuals:
object Cost
-
totalWorkspace1:
object Cost
-
totalWorkspace2:
object Cost
-
totalWorkspace3:
object Cost
-
unitPrice:
object Cost
-
unitPriceProject:
object Cost
-
unitPriceProjectActuals:
object Cost
-
unitPriceWorkspace1:
object Cost
-
unitPriceWorkspace2:
object Cost
-
unitPriceWorkspace3:
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 : ApiEntityProjectActualsLineItem
Type:
Show Source
object
-
cbsCodeId:
integer(int64)
The CBS code assigned to the actual line item.
-
costCategoryId:
integer(int64)
The type of cost associated with the actual line item.
-
hours:
object Hour
-
itemCode:
string
Allowed Values:
[ "Length[1-60]" ]
The unique identifier for an actual line item. -
itemSuffix:
integer(int64)
Auto numbering suffix of a project actuals line item code.
-
lineItemId:
integer(int64)
The unique identifier of a project actuals line item.
-
lineItemType:
string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
The type assigned to an actual line item. -
link:
string(uri)
Read Only:
true
-
name:
string
Allowed Values:
[ "Length[1-255]" ]
The name of the actual line item. -
projectActualsId:
integer(int64)
The unique identifier for the actual.
-
projectActualsLineItemCost:
object ApiEntityProjectActualsLineItemCost
-
quantity:
object Quantity
-
sourceId:
string
The unique identifier of project actual line item data in an external source.Example:
coarse
-
unitOfMeasureId:
integer(int64)
The unit of measure associated with the actual line item. This field is read-only if Total Amount or Total Hours are entered.
-
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 : 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.