Batch Create Commitments
post
/primeapi/restapi/commitment/batch
Send a request to this endpoint to create one or more commitments. An application object will be created for each JSON object provided in the request body.
Request
Supported Media Types
- application/json
One or more commitment objects.
Nested Schema : ApiEntityCommitment
Type:
Show Source
object
-
approvalDate(optional):
string(date-time)
Read Only:
true
The date on which the commitment was approved. -
approvedByUserId(optional):
integer(int64)
Read Only:
true
The system-generated identifier of the user that approved the commitment. -
awardedByCompanyId(optional):
integer(int64)
The company that awarded the commitment.
-
awardedByUserId(optional):
integer(int64)
The system-generated identifier of a user.
-
awardedToCompanyId(optional):
integer(int64)
The company that was awarded the commitment.
-
awardedToUserId(optional):
integer(int64)
The person in the Awarded To Company who is officially responsible for communications about the commitment.
-
closeDate(optional):
string(date-time)
Read Only:
true
The date on which the commitment was closed. -
codeValuesCommitment(optional):
array codeValuesCommitment
Unique Items Required:
true
-
commitmentConfiguredFields(optional):
object ApiEntityCommitmentConfiguredFields
-
commitmentCost(optional):
object ApiEntityCommitmentCost
-
commitmentId(optional):
integer(int64)
The system-genrated identfier of a commitment.
-
commitmentManagerUserId(optional):
integer(int64)
The person who is responsible for managing the commitment.
-
commitmentStatus(optional):
string
Read Only:
true
Allowed Values:[ "DRAFT", "PENDING", "APPROVED", "CLOSED", "REJECTED" ]
The status of the commitment. -
commitmentType(optional):
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(optional):
integer(int64)
The unique identifier of the commitment.
-
currencyId(optional):
integer(int64)
The unique identifier of a currency.
-
description(optional):
string
Allowed Values:
[ "Length[0-4000]" ]
Details about the commitment. -
exchangeRate(optional):
number
-
finishDate(optional):
string(date-time)
The date when the work represented by the commitment is expected to be finished.
-
itemCode:
string
Allowed Values:
[ "Length[0-60]" ]
-
link(optional):
string(url)
Read Only:
true
-
name:
string
Allowed Values:
[ "Length[0-255]" ]
The name of the commitment. -
performancePeriod(optional):
integer(int32)
The period of time during which the work captured by the commitment is planned to be done.
-
projectId:
integer(int64)
The unique identifier for the project.
-
referenceNumber(optional):
string
Allowed Values:
[ "Length[0-60]" ]
The reference number of the commitment. -
reopenDate(optional):
string(date-time)
Read Only:
true
The date on which the commitment was reopened. -
revisedFinishDate(optional):
string(date-time)
Read Only:
true
The revised finish date of the commitment. -
revisedPerformancePeriod(optional):
integer(int32)
Read Only:
true
The revised performance period of the commitment. -
revisedStartDate(optional):
string(date-time)
Read Only:
true
The revised start date of the commitment. -
securityGuid(optional):
string
Read Only:
true
The globally unique identifier of a commitment. -
sourceId(optional):
string
The unique identifier of commitment data in an external source.
-
sovapprovalDate(optional):
string(date-time)
Read Only:
true
The date on which the commitment's schedule of values was approved. -
startDate(optional):
string(date-time)
The data on which the commitment began.
-
statusTransitionData(optional):
object ApiEntityCmStatusTransitionData
-
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. -
withdrawApprovalDate(optional):
string(date-time)
Read Only:
true
The date on which approval for the commitment was withdrawn.
Nested Schema : ApiEntityCommitmentConfiguredFields
Type:
Show Source
object
-
commitmentId(optional):
integer(int64)
The system-generated identifier of a commitment.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost and non-text fields in the form of key-value pairs.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
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 : ApiEntityCommitmentCost
Type:
Show Source
object
-
commitmentId(optional):
integer(int64)
The system-generated identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.
-
currentValueCommitment(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
originalValue(optional):
object Cost
-
originalValueCommitment(optional):
object Cost
-
originalValueContract(optional):
object Cost
-
originalValueProject(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 : ApiEntityCmStatusTransitionData
Type:
Show Source
object
-
approveByUserId(optional):
integer(int64)
The user who approved the agreement, change, or payment application.
-
approveDate(optional):
string(date-time)
The date the agreement, change, or payment application was approved.
-
cancelByUserId(optional):
integer(int64)
The user who cancelled the agreement, change, or payment application.
-
cancelDate(optional):
string(date-time)
The date the agreement, change, or payment application was cancelled.
-
closeByUserId(optional):
integer(int64)
The user who closed the agreement, change order, or payment application.
-
closeDate(optional):
string(date-time)
The date the agreement, change, or payment application was closed.
-
lastStatusTransitionType(optional):
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(optional):
string(url)
Read Only:
true
-
rejectByUserId(optional):
integer(int64)
The user who rejected the agreement, change, or payment application.
-
rejectDate(optional):
string(date-time)
The date when the agreement, change, or payment application was rejected.
-
reopenDate(optional):
string(date-time)
The date when the agreement, change, or payment application was reopened.
-
rreopenByUserId(optional):
integer(int64)
The user who reopened the agreement.
-
statusTransitionId(optional):
integer(int64)
The system-generated identifier of a status transition. This value should not be provided in create operation request data, however, it is required for update requests.
-
submitByUserId(optional):
integer(int64)
The user who submitted the agreement, change, or payment application for approval.
-
submitDate(optional):
string(date-time)
The date the agreement, change, or payment application was submitted for approval.
-
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. -
voidByUserId(optional):
integer(int64)
The user who voided the agreement, change, or payment application.
-
voidDate(optional):
string(date-time)
The date the agreement, change, or payment application was voided.
-
withdrawApprovalByUserId(optional):
integer(int64)
The user who withdrew approval of the agreement, change, or payment application.
-
withdrawApprovalDate(optional):
string(date-time)
The date when approval for the agreement, change, or payment application was withdrawn.
-
withdrawByUserId(optional):
integer(int64)
The user who withdrew the agreement, change, or payment application.
-
withdrawDate(optional):
string(date-time)
The date the agreement, change, or payment application was withdrawn.
Nested Schema : ApiEntityCodeValueCommitment
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueCommitmentId:
integer(int64)
The system-generated identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.
-
commitmentId(optional):
integer(int64)
The unique identifier of the commitment.
-
link(optional):
string(url)
Read Only:
true
-
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 : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
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. -
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(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
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(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 : assignments
Type:
array
Unique Items Required:
true
CodeType 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(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
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 : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost and non-text fields in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Nested Schema : ApiEntityCommitment
Type:
Show Source
object
-
approvalDate(optional):
string(date-time)
Read Only:
true
The date on which the commitment was approved. -
approvedByUserId(optional):
integer(int64)
Read Only:
true
The system-generated identifier of the user that approved the commitment. -
awardedByCompanyId(optional):
integer(int64)
The company that awarded the commitment.
-
awardedByUserId(optional):
integer(int64)
The system-generated identifier of a user.
-
awardedToCompanyId(optional):
integer(int64)
The company that was awarded the commitment.
-
awardedToUserId(optional):
integer(int64)
The person in the Awarded To Company who is officially responsible for communications about the commitment.
-
closeDate(optional):
string(date-time)
Read Only:
true
The date on which the commitment was closed. -
codeValuesCommitment(optional):
array codeValuesCommitment
Unique Items Required:
true
-
commitmentConfiguredFields(optional):
object ApiEntityCommitmentConfiguredFields
-
commitmentCost(optional):
object ApiEntityCommitmentCost
-
commitmentId(optional):
integer(int64)
The system-genrated identfier of a commitment.
-
commitmentManagerUserId(optional):
integer(int64)
The person who is responsible for managing the commitment.
-
commitmentStatus(optional):
string
Read Only:
true
Allowed Values:[ "DRAFT", "PENDING", "APPROVED", "CLOSED", "REJECTED" ]
The status of the commitment. -
commitmentType(optional):
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(optional):
integer(int64)
The unique identifier of the commitment.
-
currencyId(optional):
integer(int64)
The unique identifier of a currency.
-
description(optional):
string
Allowed Values:
[ "Length[0-4000]" ]
Details about the commitment. -
exchangeRate(optional):
number
-
finishDate(optional):
string(date-time)
The date when the work represented by the commitment is expected to be finished.
-
itemCode:
string
Allowed Values:
[ "Length[0-60]" ]
-
link(optional):
string(url)
Read Only:
true
-
name:
string
Allowed Values:
[ "Length[0-255]" ]
The name of the commitment. -
performancePeriod(optional):
integer(int32)
The period of time during which the work captured by the commitment is planned to be done.
-
projectId:
integer(int64)
The unique identifier for the project.
-
referenceNumber(optional):
string
Allowed Values:
[ "Length[0-60]" ]
The reference number of the commitment. -
reopenDate(optional):
string(date-time)
Read Only:
true
The date on which the commitment was reopened. -
revisedFinishDate(optional):
string(date-time)
Read Only:
true
The revised finish date of the commitment. -
revisedPerformancePeriod(optional):
integer(int32)
Read Only:
true
The revised performance period of the commitment. -
revisedStartDate(optional):
string(date-time)
Read Only:
true
The revised start date of the commitment. -
securityGuid(optional):
string
Read Only:
true
The globally unique identifier of a commitment. -
sourceId(optional):
string
The unique identifier of commitment data in an external source.
-
sovapprovalDate(optional):
string(date-time)
Read Only:
true
The date on which the commitment's schedule of values was approved. -
startDate(optional):
string(date-time)
The data on which the commitment began.
-
statusTransitionData(optional):
object ApiEntityCmStatusTransitionData
-
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. -
withdrawApprovalDate(optional):
string(date-time)
Read Only:
true
The date on which approval for the commitment was withdrawn.
Nested Schema : ApiEntityCommitmentConfiguredFields
Type:
Show Source
object
-
commitmentId(optional):
integer(int64)
The system-generated identifier of a commitment.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing non-cost and non-text fields in the form of key-value pairs.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
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 : ApiEntityCommitmentCost
Type:
Show Source
object
-
commitmentId(optional):
integer(int64)
The system-generated identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.
-
currentValueCommitment(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
originalValue(optional):
object Cost
-
originalValueCommitment(optional):
object Cost
-
originalValueContract(optional):
object Cost
-
originalValueProject(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 : ApiEntityCmStatusTransitionData
Type:
Show Source
object
-
approveByUserId(optional):
integer(int64)
The user who approved the agreement, change, or payment application.
-
approveDate(optional):
string(date-time)
The date the agreement, change, or payment application was approved.
-
cancelByUserId(optional):
integer(int64)
The user who cancelled the agreement, change, or payment application.
-
cancelDate(optional):
string(date-time)
The date the agreement, change, or payment application was cancelled.
-
closeByUserId(optional):
integer(int64)
The user who closed the agreement, change order, or payment application.
-
closeDate(optional):
string(date-time)
The date the agreement, change, or payment application was closed.
-
lastStatusTransitionType(optional):
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(optional):
string(url)
Read Only:
true
-
rejectByUserId(optional):
integer(int64)
The user who rejected the agreement, change, or payment application.
-
rejectDate(optional):
string(date-time)
The date when the agreement, change, or payment application was rejected.
-
reopenDate(optional):
string(date-time)
The date when the agreement, change, or payment application was reopened.
-
rreopenByUserId(optional):
integer(int64)
The user who reopened the agreement.
-
statusTransitionId(optional):
integer(int64)
The system-generated identifier of a status transition. This value should not be provided in create operation request data, however, it is required for update requests.
-
submitByUserId(optional):
integer(int64)
The user who submitted the agreement, change, or payment application for approval.
-
submitDate(optional):
string(date-time)
The date the agreement, change, or payment application was submitted for approval.
-
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. -
voidByUserId(optional):
integer(int64)
The user who voided the agreement, change, or payment application.
-
voidDate(optional):
string(date-time)
The date the agreement, change, or payment application was voided.
-
withdrawApprovalByUserId(optional):
integer(int64)
The user who withdrew approval of the agreement, change, or payment application.
-
withdrawApprovalDate(optional):
string(date-time)
The date when approval for the agreement, change, or payment application was withdrawn.
-
withdrawByUserId(optional):
integer(int64)
The user who withdrew the agreement, change, or payment application.
-
withdrawDate(optional):
string(date-time)
The date the agreement, change, or payment application was withdrawn.
Nested Schema : ApiEntityCodeValueCommitment
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueCommitmentId:
integer(int64)
The system-generated identifier of a commitment. This value should not be provided in create operation request data, however, it is required for update requests.
-
commitmentId(optional):
integer(int64)
The unique identifier of the commitment.
-
link(optional):
string(url)
Read Only:
true
-
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 : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
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. -
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(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
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(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 : assignments
Type:
array
Unique Items Required:
true
CodeType 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(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
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 : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing non-cost and non-text fields in the form of key-value pairs.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
400 Response
Invalid input for the Commitment service. Verify the request contains valid data, then resubmit the request.