Batch Integrate Project Actuals Line Items with an External Data Source
post
/api/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
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityExternallySourcedProjectActualsLineItemInput>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedProjectActualsLineItemInput>
-
Array of:
object ApiEntityExternallySourcedProjectActualsLineItemInput
Title:
ApiEntityExternallySourcedProjectActualsLineItemInput
This entity represents a ExternallySourcedProjectActualsLineItem object, a unique ExternallySourcedProjectActualsLineItem object can be identified by the following combinations of the fields.- projectActualsLineItemId
- projectActualsLineItemCode,projectActualsId
- projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode
Nested Schema : ApiEntityExternallySourcedProjectActualsLineItemInput
Type:
object
Title:
ApiEntityExternallySourcedProjectActualsLineItemInput
This entity represents a ExternallySourcedProjectActualsLineItem object, a unique ExternallySourcedProjectActualsLineItem object can be identified by the following combinations of the fields.
Show Source
- projectActualsLineItemId
- projectActualsLineItemCode,projectActualsId
- projectActualsLineItemCode,projectActualsCode,projectCode,workspaceCode
-
cbsCode: stringMinimum Length:1
Maximum Length:60
Deprecated. As of 23.5, replaced by 'ApiEntityProjectActualsLineItem.cbsCodes'.The user-specified identifier of a CBS. -
cbsCodes: array
cbsCodes
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
-
cbsCodeSourceId: string
Maximum Length:
255
The unique identifier of CBS data in an external source. -
cbsSheetCodeId: integer
(int64)
The CBS code assigned to the actual line item.
-
costCategoryAbbreviation: string
Minimum Length:
1
Maximum Length:10
The abbreviated name of a cost category. -
costCategoryId: integer
(int64)
The system-generated identifier of cost category associated with the project actual line item.
-
costCategoryName: string
Minimum Length:
1
Maximum Length:255
The name of the cost category associated with the project actual line item. -
hours: number
(double)
The number of hours needed to complete the actual line item.
-
itemSuffix: integer(int64)Deprecated. As of 23.11.Auto numbering suffix of a project actuals line item code. -
lineItemType: string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
The type assigned to an actual line item. -
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
name(required): string
Minimum Length:
1
Maximum Length:255
The name of the actual line item. -
projectActualsCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a project actual. -
projectActualsId(required): integer
(int64)
The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.
-
projectActualsLineItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for an actual line item. -
projectActualsLineItemCost(required):
projectActualsLineItemCost
The cost fields associated with a line item.
-
projectActualsLineItemId: integer
(int64)
The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
-
projectActualsSourceId: string
Maximum Length:
255
The unique identifier of project actual data in an external source. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a project. -
quantity: integer
(int64)
The quantity of the actual line item.
If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered.
If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure. -
sourceId: string
Maximum Length:
255
The unique identifier of project actual line item data in an external source. -
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
Minimum Length:
0
Maximum Length:255
The value of a units of measure. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : cbsCodes
Type:
array
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : projectActualsLineItemCost
The cost fields associated with a line item.
Match All
Show Source
-
object
ApiEntityProjectActualsLineItemCostInput
Title:
ApiEntityProjectActualsLineItemCostInput
Nested Schema : ApiEntityProjectActualsLineItemCostInput
Type:
object
Title:
Show Source
ApiEntityProjectActualsLineItemCostInput
-
link: string(url)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
projectActualsLineItem:projectActualsLineItemDeprecated. As of 23.6.The system-generated identifier of a line item. -
projectActualsLineItemId: integer
(int64)
The system-generated identifier of a project actual line item.
-
total: number(double)Read Only:true
Deprecated. As of 23.11.The cost amount associated with the actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalProject field based on the specified exchange rate. -
totalProject: number(double)Read Only:true
Deprecated. As of 23.11.The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the project currency. -
totalProjectActuals(required): number
(double)
The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the record level currency.
-
totalWorkspace1: number(double)Read Only:true
Deprecated. As of 23.11.The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace1 currency. -
totalWorkspace2: number(double)Read Only:true
Deprecated. As of 23.11.The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace2 currency. -
totalWorkspace3: number(double)Read Only:true
Deprecated. As of 23.11.The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace3 currency. -
unitPrice: number(double)Read Only:true
Deprecated. As of 23.11.The price associated with the actual line item.
If a Unit of Measure is associated with the actual line item, the Unit Price is the unit price per measure. This field is in base currency and is calculated from unitPriceProject field based on the specified exchange rate. -
unitPriceProject: number(double)Read Only:true
Deprecated. As of 23.11.The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the project currency. -
unitPriceProjectActuals: number
(double)
The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the record level currency.
-
unitPriceWorkspace1: number(double)Read Only:true
Deprecated. As of 23.11.The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace1 currency. -
unitPriceWorkspace2: number(double)Read Only:true
Deprecated. As of 23.11.The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace2 currency. -
unitPriceWorkspace3: number(double)Read Only:true
Deprecated. As of 23.11.The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace3 currency. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : projectActualsLineItem
Deprecated. As of 23.6.The system-generated identifier of a line item.
Match All
Show Source
-
object
ApiEntityProjectActualsLineItem
Title:
ApiEntityProjectActualsLineItem
Nested Schema : ApiEntityProjectActualsLineItem
Type:
object
Title:
Show Source
ApiEntityProjectActualsLineItem
-
cbsCodes: array
cbsCodes
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
-
cbsCodeSourceId: string
Maximum Length:
255
The unique identifier of CBS data in an external source. -
cbsSheetCodeId: integer
(int64)
The CBS code assigned to the actual line item.
-
costCategoryAbbreviation: string
Minimum Length:
1
Maximum Length:10
The abbreviated name of a cost category. -
costCategoryId: integer
(int64)
The system-generated identifier of cost category associated with the project actual line item.
-
costCategoryName: string
Minimum Length:
1
Maximum Length:255
The name of the cost category associated with the project actual line item. -
hours: number
(double)
The number of hours needed to complete the actual line item.
-
itemSuffix: integer
(int64)
Auto numbering suffix of a project actuals line item code.
-
lineItemType: string
Allowed Values:
[ "LUMP_SUM", "UNIT_PRICE" ]
The type assigned to an actual line item. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
name: string
Minimum Length:
1
Maximum Length:255
The name of the actual line item. -
projectActualsCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a project actual. -
projectActualsId: integer
(int64)
The unique identifier for the project actuals.The project actuals object can also be identified by its unique criteria.
-
projectActualsLineItemCode: string
Minimum Length:
1
Maximum Length:60
The user-specified unique identifier for an actual line item. -
projectActualsLineItemCost:
projectActualsLineItemCost
The cost fields associated with a line item.
-
projectActualsLineItemId: integer
(int64)
The unique identifier for the project actuals line item. The project actuals line item object can also be identified by its unique criteria. This value should not be provided in create operation request data, however, it is required for update requests.
-
projectActualsSourceId: string
Maximum Length:
255
The unique identifier of project actual data in an external source. -
projectCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a project. -
quantity: integer
(int64)
The quantity of the actual line item.
If Total is entered, you cannot enter Quantity. If a Unit Price is entered, Quantity must be entered.
If a Unit of Measure is selected, the Quantity value is displayed as Quantity of Measure. -
sourceId: string
Maximum Length:
255
The unique identifier of project actual line item data in an external source. -
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
Minimum Length:
0
Maximum Length:255
The value of a units of measure. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : cbsCodes
Type:
array
List of cbs codes in hierarchy for the CBS which needs to be associated with the item. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
Nested Schema : projectActualsLineItemCost
The cost fields associated with a line item.
Match All
Show Source
-
object
ApiEntityProjectActualsLineItemCost
Title:
ApiEntityProjectActualsLineItemCost
Nested Schema : ApiEntityProjectActualsLineItemCost
Type:
object
Title:
Show Source
ApiEntityProjectActualsLineItemCost
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
projectActualsLineItem:projectActualsLineItemDeprecated. As of 23.6.The system-generated identifier of a line item. -
projectActualsLineItemId: integer
(int64)
The system-generated identifier of a project actual line item.
-
total: number
(double)
The cost amount associated with the actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalProject field based on the specified exchange rate.
-
totalProject: number
(double)
The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the project currency.
-
totalProjectActuals: number
(double)
The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the record level currency.
-
totalWorkspace1: number
(double)
The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace1 currency.
-
totalWorkspace2: number
(double)
The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace2 currency.
-
totalWorkspace3: number
(double)
The cost amount associated with the actual line item. The value can be positive or negative. This value is based on the workspace3 currency.
-
unitPrice: number
(double)
The price associated with the actual line item.
If a Unit of Measure is associated with the actual line item, the Unit Price is the unit price per measure. This field is in base currency and is calculated from unitPriceProject field based on the specified exchange rate. -
unitPriceProject: number
(double)
The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the project currency.
-
unitPriceProjectActuals: number
(double)
The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the record level currency.
-
unitPriceWorkspace1: number
(double)
The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace1 currency.
-
unitPriceWorkspace2: number
(double)
The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace2 currency.
-
unitPriceWorkspace3: number
(double)
The price associated with the actual line item. If a unit of measure is associated with the actual line item, the unit price is the unit price per measure. This value is based on the workspace3 currency.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : projectActualsLineItem
Deprecated. As of 23.6.The system-generated identifier of a line item.
Match All
Show Source
-
object
ApiEntityProjectActualsLineItem
Title:
ApiEntityProjectActualsLineItem
Examples
Back to Top
Response
Supported Media Types
- application/json
207 Response
The object was successfully integrated.
Root Schema : List<ApiEntityERPSyncApiResponse>
Type:
array
Title:
Show Source
List<ApiEntityERPSyncApiResponse>
-
Array of:
object ApiEntityERPSyncApiResponse
Title:
ApiEntityERPSyncApiResponse
Nested Schema : ApiEntityERPSyncApiResponse
Type:
object
Title:
Show Source
ApiEntityERPSyncApiResponse
-
identifier: object
identifier
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked. -
link: string
(url)
Read Only:
true
The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
message: string
Message is populated based on result of the operation.
Success - Message will not be populated. Please refer the statusCode.
Failure - Error message or reason for operation failure is populated.
Warning - warning message is populated.
The field is non-persistable and thus maximum length is not applicable. -
primaryKeyName: string
The primary key field name associated with the integrated object.
The field is non-persistable and thus maximum length is not applicable. -
primaryKeyValue: integer
(int64)
The unique identifier for the integrated object.
-
sourceId: string
Maximum Length:
255
The unique identifier of the object in an external source. -
statusCode: integer
(int32)
The response code representing the state of the API operation.
-
updateDate: string
(date-time)
Read Only:
true
Date when the record was last updated.
Nested Schema : identifier
Type:
object
The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
Match One Schema
Show Source
-
object
ProjectIdentifier
Title:
ProjectIdentifier
-
object
CBSSheetCodeIdentifier
Title:
CBSSheetCodeIdentifier
-
object
ResourceIdentifier
Title:
ResourceIdentifier
Nested Schema : ProjectIdentifier
Type:
object
Title:
Show Source
ProjectIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : CBSSheetCodeIdentifier
Type:
object
Title:
Show Source
CBSSheetCodeIdentifier
-
cbsCode: string
Maximum Length:
60
The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition. -
cbsSheetCodeId: 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.
-
costSheetId: integer
(int64)
The unique identifier of a cost sheet.
-
parentId: integer
(int64)
The system-generated identifier of a parent cost item in a cost sheet.
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ResourceIdentifier
Type:
object
Title:
Show Source
ResourceIdentifier
-
projectCode: string
Maximum Length:
60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class identifies the item as a resource or a role. -
resourceCode: string
Maximum Length:
60
The unique identifier for the resource or role. -
resourceId: integer
(int64)
The unique identifier for the resource or role.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
400 Response
Invalid Input.