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
Body ()
One or more commitment objects.
Root Schema : List<ApiEntityCommitment>
Type: array
Title: List<ApiEntityCommitment>
Show Source
Nested Schema : ApiEntityCommitment
Type: object
Show Source
Nested Schema : codeValuesCommitment
Type: array
Unique Items Required: true
Show Source
Nested Schema : ApiEntityCommitmentConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityCommitmentCost
Type: object
Show Source
Nested Schema : ApiEntityCmStatusTransitionData
Type: object
Show Source
Nested Schema : ApiEntityCodeValueCommitment
Type: object
Show Source
Nested Schema : ApiEntityCodeType
Type: object
Show Source
Nested Schema : ApiEntityCodeValue
Type: object
Show Source
Nested Schema : assignments
Type: array
Unique Items Required: true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type: object
Show Source
  • ApiEntityCodeType
  • 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.
  • The unique identifier of a code type table.
  • 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

201 Response

The object was successfully created.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : ApiEntityCommitment
Type: object
Show Source
Nested Schema : codeValuesCommitment
Type: array
Unique Items Required: true
Show Source
Nested Schema : ApiEntityCommitmentConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityCommitmentCost
Type: object
Show Source
Nested Schema : ApiEntityCmStatusTransitionData
Type: object
Show Source
Nested Schema : ApiEntityCodeValueCommitment
Type: object
Show Source
Nested Schema : ApiEntityCodeType
Type: object
Show Source
Nested Schema : ApiEntityCodeValue
Type: object
Show Source
Nested Schema : assignments
Type: array
Unique Items Required: true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type: object
Show Source
  • ApiEntityCodeType
  • 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.
  • The unique identifier of a code type table.
  • 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.