Integrate Change Orders with an External Data Source
To integrate change orders with an external data source:
- Retrieve the
itemCode
projectId
commitmentStatus
- Endpoint:
https://localhost:7001/primeapi/restapi/project/commitment/externallySourced?filters=commitmentStatus=APPROVED
- Operation:
GET
- Endpoint:
- Create or generate one or more JSON objects containing the following properties:
- sourceId: The unique identifier of the change order data in an external resource, such as an ERP system.
- associatedAgreementCode: The code of an approved commitment this change order will be associated with.
- name: The name of the change order.
- projectId: The unique identifier of a project containing the commitment this change order will be associated with.
- type: The type of agreement the change order is associated with.
- Send a request to the API using the following information:
- Endpoint:
https://localhost:7001/primeapi/restapi/project/changeOrder/syncBatch
- Operation:
POST
- Example Request Body:
[ { "sourceId": 1, "associatedAgreementCode":"Example Commitment", "name": "Example Change Order", "projectId": 1304, "type":"COMMITMENT" },
{ "sourceId": 2, "associatedAgreementCode":"Example Commitment Two", "name": "Example Change Order Two", "projectId": 1304, "type":"COMMITMENT" }, ]
- Endpoint:
- The API should return a response similar to the following:
- Response Code: 207
- Example Response Body:
[ { "statusCode": 201, "primaryKeyName": "changeOrderId", "primaryKeyValue": 14001, "sourceId": "1" }, { "statusCode": 201, "primaryKeyName": "changeOrderId", "primaryKeyValue": 14002, "sourceId": "2" } ]