Integrate a Commitment with an External Data Source
post
/primeapi/restapi/commitment/sync
Send a request to this endpoint to create or update an integrated a commitment. 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 commitment data in an external source.
Root Schema : ApiEntityExternallySourcedCommitment
Type:
Show Source
object-
approvalDate:
string(date-time)
The date on which the commitment was approved.
-
approveByUserName:
string
The name of the user that approved the commitment.
-
approvedByUserId:
integer(int64)
The system-generated identifier of the user that approved the commitment.
-
awardedByCompanyId:
integer(int64)
The company that awarded the commitment.
-
awardedByUserId:
integer(int64)
The system-generated identifier of a user.
-
awardedToCompanyId:
integer(int64)
The company that was awarded the commitment.
-
awardedToUserId:
integer(int64)
The person in the Awarded To Company who is officially responsible for communications about the commitment.
-
closeByUserName:
string
The name of the user that closed the commitment.
-
closeDate:
string(date-time)
The date on which the commitment was closed.
-
codeValuesCommitment:
array codeValuesCommitment
Unique Items Required:
true -
commitmentConfiguredFields:
object ApiEntityCommitmentConfiguredFields
-
commitmentCost:
object ApiEntityCommitmentCost
-
commitmentId:
integer(int64)
The system-generated identifier of a commitment.
-
commitmentManagerUserId:
integer(int64)
The person who is responsible for managing the commitment.
-
commitmentManagerUserName:
string
-
commitmentStatus:
string
Allowed Values:
[ "DRAFT", "APPROVED", "CLOSED" ]The status of the commitment. -
commitmentType:
string
Allowed Values:
[ "NONE", "COST_PLUS_FIXED_FEE", "COST_PLUS_PCT_FEE", "GUARANTEED_MAX_PRICE", "LUMP_SUM", "UNIT_PRICE", "TIME_AND_MATERIAL" ]The type of the commitment. -
contractId:
integer(int64)
The unique identifier of the commitment.
-
currencyCode:
string
-
currencyId:
integer(int64)
The unique identifier of a currency.
-
description:
string
Allowed Values:
[ "Length[0-4000]" ]Details about the commitment. -
exchangeRate:
number
-
finishDate:
string(date-time)
The date when the work represented by the commitment is expected to be finished.
-
fromCompanyName:
string
The company that awarded the commitment.
-
fromCompanyPostalCode:
string
The postal code of the company that awarded the commitment.
-
fromCompanySiteId:
string
The unique identifier of the site of the company that awarded the commitment.
-
fromCompanySourceId:
string
The unique identifier of company data in an external source.
-
fromContactUserName:
string
The person at the company that awarded the commitment who is officially responsible for communications about the commitment.
-
itemCode:
string
Allowed Values:
[ "Length[0-60]" ] -
lastStatusAction:
string
Allowed Values:
[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "CLOSE", "REOPEN", "REJECT", "VOID", "WITHDRAW", "ANSWERED", "NONE" ]The last status of the agreement, change, or payment application. -
link:
string(uri)
Read Only:
true -
name:
string
Allowed Values:
[ "Length[0-255]" ]The name of the commitment. -
performancePeriod:
integer(int32)
The period of time during which the work captured by the commitment is planned to be done.
-
projectCode:
string
The user-specified identifier of a project.
-
projectId:
integer(int64)
The unique identifier for the project.
-
projectSourceId:
string
The unique identifier of a project in an external source.
-
referenceNumber:
string
Allowed Values:
[ "Length[0-60]" ]The reference number of the commitment. -
rejectByUserName:
string
The user who rejected the commitment.
-
rejectedDate:
string(date-time)
The date when the agreement, change, or payment application was rejected.
-
reopenByUserName:
string
The user who reopened the commitment.
-
reopenDate:
string(date-time)
The date on which the commitment was reopened.
-
revisedFinishDate:
string(date-time)
The revised finish date of the commitment.
-
revisedPerformancePeriod:
integer(int32)
The revised performance period of the commitment.
-
revisedStartDate:
string(date-time)
The revised start date of the commitment.
-
securityGuid:
string
The globally unique identifier of a commitment.
-
sourceId:
string
The unique identifier of commitment data in an external source.Example:
coarse -
sovapprovalDate:
string(date-time)
The date on which the commitment's schedule of values was approved.
-
startDate:
string(date-time)
The data on which the commitment began.
-
statusTransitionData:
object ApiEntityCmStatusTransitionData
-
submitByUserName:
string
The user who submitted the commitment.
-
submitedDate:
string(date-time)
The date the agreement, change, or payment application was submitted for approval.
-
toCompanyName:
string
The company the commitment was awarded to.
-
toCompanyPostalCode:
string
The postal code of the company the commitment was awarded to.
-
toCompanySiteId:
string
The site of the company the commitment was awarded to.
-
toCompanySourceId:
string
The unique identifier of the company the commitment was awarded to.
-
toContactUserName:
string
The user assigned as a contact for the commitment.
-
updateDate:
string(date-time)
Read Only:
trueThe 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. -
withdrawApprovalByUserName:
string
The user who withdrew approval of the commitment.
-
withdrawApprovalDate:
string(date-time)
The date on which approval for the commitment was withdrawn.
-
workspaceCode:
string
The user-specified identifier of a workspace.
Nested Schema : ApiEntityCommitmentConfiguredFields
Type:
Show Source
object-
commitmentId:
integer(int64)
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalProperties
-
link:
string(uri)
Read Only:
true -
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalProperties
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalProperties
-
updateDate:
string(date-time)
Read Only:
trueThe 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 : ApiEntityCommitmentCost
Type:
Show Source
object-
commitmentId:
integer(int64)
-
currentValueCommitment:
object Cost
-
link:
string(uri)
Read Only:
true -
originalValue:
object Cost
-
originalValueCommitment:
object Cost
-
originalValueContract:
object Cost
-
originalValueProject:
object Cost
-
updateDate:
string(date-time)
Read Only:
trueThe 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 : ApiEntityCmStatusTransitionData
Type:
Show Source
object-
approveByUserId:
integer(int64)
The user who approved the agreement, change, or payment application.
-
approveDate:
string(date-time)
The date the agreement, change, or payment application was approved.
-
cancelByUserId:
integer(int64)
The user who cancelled the agreement, change, or payment application.
-
cancelDate:
string(date-time)
The date the agreement, change, or payment application was cancelled.
-
closeByUserId:
integer(int64)
The user who closed the agreement, change order, or payment application.
-
closeDate:
string(date-time)
The date the agreement, change, or payment application was closed.
-
lastStatusTransitionType:
string
Allowed Values:
[ "SUBMIT", "APPROVE", "WITHDRAW_APPROVAL", "CLOSE", "REOPEN", "REJECT", "VOID", "WITHDRAW", "ANSWERED", "NONE" ]The last status of the agreement, change, or payment application. -
link:
string(uri)
Read Only:
true -
rejectByUserId:
integer(int64)
The user who rejected the agreement, change, or payment application.
-
rejectDate:
string(date-time)
The date when the agreement, change, or payment application was rejected.
-
reopenDate:
string(date-time)
The date when the agreement, change, or payment application was reopened.
-
rreopenByUserId:
integer(int64)
The user who reopened the agreement.
-
statusTransitionId:
integer(int64)
The system-generated identifier of a status transition.
-
submitByUserId:
integer(int64)
The user who submitted the agreement, change, or payment application for approval.
-
submitDate:
string(date-time)
The date the agreement, change, or payment application was submitted for approval.
-
updateDate:
string(date-time)
Read Only:
trueThe 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. -
voidByUserId:
integer(int64)
The user who voided the agreement, change, or payment application.
-
voidDate:
string(date-time)
The date the agreement, change, or payment application was voided.
-
withdrawApprovalByUserId:
integer(int64)
The user who withdrew approval of the agreement, change, or payment application.
-
withdrawApprovalDate:
string(date-time)
The date when approval for the agreement, change, or payment application was withdrawn.
-
withdrawByUserId:
integer(int64)
The user who withdrew the agreement, change, or payment application.
-
withdrawDate:
string(date-time)
The date the agreement, change, or payment application was withdrawn.
Nested Schema : ApiEntityCodeValueCommitment
Type:
Show Source
object-
codeType:
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueCommitmentId:
integer(int64)
The system-generated identifier of a commitment.
-
commitmentId:
integer(int64)
The unique identifier of the commitment.
-
link:
string(uri)
Read Only:
true -
updateDate:
string(date-time)
Read Only:
trueThe 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 : ApiEntityCodeType
Type:
Show Source
object-
assignments:
array assignments
Unique Items Required:
trueCodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]This field displays the name of a code or value. -
codeTypeId:
integer(int64)
PRIMAVERA_DB_DOCUMENT:CO_CODE_TYPE,CODE_TYPE_ID
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]The name of a code or value. -
link:
string(uri)
Read Only:
true -
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]The push down type of the workspace code. -
updateDate:
string(date-time)
Read Only:
trueThe 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. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]The unique identifier for the code value. -
codeValueId:
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]The name of the code value. -
link:
string(uri)
Read Only:
true -
parentCodeValue:
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate:
string(date-time)
Read Only:
trueThe 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 : assignments
Type:
arrayUnique Items Required:
trueCodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]Indicates the type of object the code is associated to. -
link:
string(uri)
Read Only:
true -
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
updateDate:
string(date-time)
Read Only:
trueThe 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 : additionalProperties
Type:
objectNested Schema : additionalProperties
Type:
objectNested Schema : additionalProperties
Type:
objectNested Schema : Cost
Type:
objectResponse
Supported Media Types
- application/json
200 Response
Successful Update Operation.
Root 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:
trueThe 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.
201 Response
Successful Create Operation.
Root 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:
trueThe 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.