Batch Integrate Project Actuals Data with an External Data Source
post
/api/restapi/projectActuals/syncBatch
Send a request to this endpoint to create or update one or more integrated project actuals data. 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<ApiEntityExternallySourcedProjectActualsInput>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedProjectActualsInput>
-
Array of:
object ApiEntityExternallySourcedProjectActualsInput
Title:
ApiEntityExternallySourcedProjectActualsInput
This entity represents a ExternallySourcedProjectActuals object, a unique ExternallySourcedProjectActuals object can be identified by the following combinations of the fields.- projectActualsId
- projectActualsCode,projectId
- projectActualsCode,projectCode,workspaceCode
Nested Schema : ApiEntityExternallySourcedProjectActualsInput
Type:
object
Title:
ApiEntityExternallySourcedProjectActualsInput
This entity represents a ExternallySourcedProjectActuals object, a unique ExternallySourcedProjectActuals object can be identified by the following combinations of the fields.
Show Source
- projectActualsId
- projectActualsCode,projectId
- projectActualsCode,projectCode,workspaceCode
-
approvedByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user who approved the item. -
approvedDate: string(date-time)Read Only:true
Deprecated. As of 23.11.The date that the actual was approved. -
companyName: string
Minimum Length:
1
Maximum Length:255
The name of a company. -
companySourceId: string
Maximum Length:
255
The unique identifier of company data in an external source. -
configuredFields: array
configuredFields
The list of configured fields for a project actuals.
-
confirmedByEmailAddress: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.Indicates whether or not the project actual has been confirmed via email. -
currencyCode: string
Minimum Length:
1
Maximum Length:3
The user-specified identifier of a currency. -
currencyId: integer
(int64)
The system-generated identifier of the currency associated with the project actual.
-
description: string
Minimum Length:
0
Maximum Length:4000
Details about the project actual. -
effectiveDate: string
(date-time)
The date the actual is effective.
-
fixedExchangeRate: number
The exchange rate used to convert the Total Amount value from the record currency to the base currency.
-
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. -
projectActualName(required): string
Minimum Length:
1
Maximum Length:255
The name of the actual. -
projectActualsCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for an actual. -
projectActualsCost:
projectActualsCost
An object containing cost fields in the form of key-value pairs.
-
projectActualsId: integer
(int64)
The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a project. -
projectCompanyId: integer
(int64)
The name of the company associated with the actual.
-
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
projectSourceId: string
Maximum Length:
255
The unique identifier of project data in an external source. -
sourceId: string
Maximum Length:
255
The unique identifier of project actual data in an external source.Example:coarse
-
status: string
Allowed Values:
[ "PENDING", "CONFIRMED" ]
That status of the actual. Valid values are Pending and Confirmed. -
totalHours: number(double)Read Only:true
Deprecated. As of 23.11.Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
withdrawByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier of the user who withdrew confirmation of the project actual. -
withdrawConfirmedByEmailAddress: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.Indicates whether or not the actual withdrawl has been confirmed via email. -
withdrawDate: string(date-time)Read Only:true
Deprecated. As of 23.11.The date that confirmation of the project actual was withdrawn. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : configuredFields
Type:
array
The list of configured fields for a project actuals.
Show Source
-
Array of:
object ApiEntityProjectActualsConfiguredFieldValueInput
Title:
ApiEntityProjectActualsConfiguredFieldValueInput
This entity represents a ProjectActualsConfiguredFieldValue object, a unique ProjectActualsConfiguredFieldValue object can be identified by the following combinations of the fields.- projectActualsConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : projectActualsCost
An object containing cost fields in the form of key-value pairs.
Match All
Show Source
-
object
ApiEntityProjectActualsCostInput
Title:
ApiEntityProjectActualsCostInput
Nested Schema : ApiEntityProjectActualsConfiguredFieldValueInput
Type:
object
Title:
ApiEntityProjectActualsConfiguredFieldValueInput
This entity represents a ProjectActualsConfiguredFieldValue object, a unique ProjectActualsConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- projectActualsConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: numberRead Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record. -
costValueProject: number(double)Deprecated. As of 23.11.This holds value of Cost type configured fields in the project level currency conversion. Input should be provided in numberValue field, in project actuals record level currency. -
costValueWorkspace1: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace3 currency conversion. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead Only:true
Deprecated. As of 23.10.Determines if formula calculation hit an error calculating a value for this field. -
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. -
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
projectActualsConfiguredFieldValueId: integer
(int64)
The unique identifier for the Project Actuals Configured Field.
-
projectActualsId: integer
(int64)
The system-generated identifier for an Actual.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityProjectActualsCostInput
Type:
object
Title:
Show Source
ApiEntityProjectActualsCostInput
-
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. -
projectActuals:
projectActuals
The supporting details for the project actuals.
-
projectActualsId: integer
(int64)
The unique identifier of project actual data.
-
totalAmount: number(double)Read Only:true
Deprecated. As of 23.11.Total Amount is calculated as the sum of the Amount of each actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalAmountProject field based on the specified exchange rate. -
totalAmountProject: number(double)Read Only:true
Deprecated. As of 23.11.The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the project currency. -
totalAmountProjectActuals: number(double)Read Only:true
Deprecated. As of 23.11.The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the record level currency. -
totalAmountWorkspace1: number(double)Read Only:true
Deprecated. As of 23.11.The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace1 currency. -
totalAmountWorkspace2: number(double)Read Only:true
Deprecated. As of 23.11.The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace2 currency. -
totalAmountWorkspace3: number(double)Read Only:true
Deprecated. As of 23.11.The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. 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 : projectActuals
The supporting details for the project actuals.
Match All
Show Source
-
object
ApiEntityProjectActualsInput
Title:
ApiEntityProjectActualsInput
This entity represents a ProjectActuals object, a unique ProjectActuals object can be identified by the following combinations of the fields.- projectActualsId
- projectActualsCode,projectId
- projectActualsCode,projectCode,workspaceCode
Nested Schema : ApiEntityProjectActualsInput
Type:
object
Title:
ApiEntityProjectActualsInput
This entity represents a ProjectActuals object, a unique ProjectActuals object can be identified by the following combinations of the fields.
Show Source
- projectActualsId
- projectActualsCode,projectId
- projectActualsCode,projectCode,workspaceCode
-
approvedByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The username of the user who approved the item. -
approvedDate: string(date-time)Read Only:true
Deprecated. As of 23.11.The date that the actual was approved. -
companyName: string
Minimum Length:
1
Maximum Length:255
The name of a company. -
companySourceId: string
Maximum Length:
255
The unique identifier of company data in an external source. -
configuredFields: array
configuredFields
The list of configured fields for a project actuals.
-
confirmedByEmailAddress: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.Indicates whether or not the project actual has been confirmed via email. -
currencyCode: string
Minimum Length:
1
Maximum Length:3
The user-specified identifier of a currency. -
currencyId: integer
(int64)
The system-generated identifier of the currency associated with the project actual.
-
description: string
Minimum Length:
0
Maximum Length:4000
Details about the project actual. -
effectiveDate: string
(date-time)
The date the actual is effective.
-
fixedExchangeRate: number
The exchange rate used to convert the Total Amount value from the record currency to the base currency.
-
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. -
projectActualName(required): string
Minimum Length:
1
Maximum Length:255
The name of the actual. -
projectActualsCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for an actual. -
projectActualsCost:
projectActualsCost
An object containing cost fields in the form of key-value pairs.
-
projectActualsId: integer
(int64)
The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a project. -
projectCompanyId: integer
(int64)
The name of the company associated with the actual.
-
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
projectSourceId: string
Maximum Length:
255
The unique identifier of project data in an external source. -
sourceId: string
Maximum Length:
255
The unique identifier of project actual data in an external source.Example:coarse
-
status: string
Allowed Values:
[ "PENDING", "CONFIRMED" ]
That status of the actual. Valid values are Pending and Confirmed. -
totalHours: number(double)Read Only:true
Deprecated. As of 23.11.Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
withdrawByUserId: integer(int64)Read Only:true
Deprecated. As of 23.11.The system-generated identifier of the user who withdrew confirmation of the project actual. -
withdrawConfirmedByEmailAddress: stringRead Only:true
Maximum Length:255
Deprecated. As of 23.11.Indicates whether or not the actual withdrawl has been confirmed via email. -
withdrawDate: string(date-time)Read Only:true
Deprecated. As of 23.11.The date that confirmation of the project actual was withdrawn. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Nested Schema : configuredFields
Type:
array
The list of configured fields for a project actuals.
Show Source
-
Array of:
object ApiEntityProjectActualsConfiguredFieldValueInput
Title:
ApiEntityProjectActualsConfiguredFieldValueInput
This entity represents a ProjectActualsConfiguredFieldValue object, a unique ProjectActualsConfiguredFieldValue object can be identified by the following combinations of the fields.- projectActualsConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : projectActualsCost
An object containing cost fields in the form of key-value pairs.
Match All
Show Source
-
object
ApiEntityProjectActualsCostInput
Title:
ApiEntityProjectActualsCostInput
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.