engChangeOrderDocument Resource Type

Use the "engChangeOrderDocument" API to manage ECO-related documents (for example, CAD files or specifications) and mark them to be changed.

• API version: v2.0
• Publisher: cosmoconsult
• Group: productdatamanagement
• Base (SaaS): https://api.businesscentral.dynamics.com/v2.0/{tenant}/Production/api/cosmoconsult/productdatamanagement/v2.0
• Base (On‑Prem): https://{host}/{container}rest/api/cosmoconsult/productdatamanagement/v2.0
• Metadata: {Base}/$metadata?tenant=default&$schemaversion=2.0

Permissions

Requires access to the target company and permissions to read/write ECO documents.

Methods

Operation	Company‑scoped	Unscoped
List documents	GET /companies({companyId})/engChangeOrderDocuments	GET /engChangeOrderDocuments
Create document	POST /companies({companyId})/engChangeOrderDocuments	POST /engChangeOrderDocuments
Get document	GET /companies({companyId})/engChangeOrderDocuments({id})	GET /engChangeOrderDocuments({id})
Update document	PATCH /companies({companyId})/engChangeOrderDocuments({id})	PATCH /engChangeOrderDocuments({id})
Delete document	DELETE /companies({companyId})/engChangeOrderDocuments({id})	DELETE /engChangeOrderDocuments({id})
Get ECO change description (media, via document)	GET /companies({companyId})/engChangeOrderDocuments({id})/engChangeOrder/changeDescription	GET /engChangeOrderDocuments({id})/engChangeOrder/changeDescription
Update ECO change description (media, via document)	PUT /companies({companyId})/engChangeOrderDocuments({id})/engChangeOrder/changeDescription	PUT /engChangeOrderDocuments({id})/engChangeOrder/changeDescription

Endpoints

Company‑scoped

• GET/POST /companies({companyId})/engChangeOrderDocuments
• GET/PATCH/DELETE /companies({companyId})/engChangeOrderDocuments({id})
• GET/PATCH/DELETE /companies({companyId})/engChangeOrderDocuments({id})/engChangeOrder
• GET/PUT /companies({companyId})/engChangeOrderDocuments({id})/engChangeOrder/changeDescription (media)
• via ECO navigation:
  • GET/POST /companies({companyId})/engChangeOrders({ecoId})/engChangeOrderDocuments
  • GET/PATCH/DELETE /companies({companyId})/engChangeOrders({ecoId})/engChangeOrderDocuments({id})

Unscoped

• GET/POST /engChangeOrderDocuments
• GET/PATCH/DELETE /engChangeOrderDocuments({id})
• GET/PATCH/DELETE /engChangeOrderDocuments({id})/engChangeOrder
• GET/PUT /engChangeOrderDocuments({id})/engChangeOrder/changeDescription (media)
• via ECO navigation:
  • GET/POST /engChangeOrders({ecoId})/engChangeOrderDocuments
  • GET/PATCH/DELETE /engChangeOrders({ecoId})/engChangeOrderDocuments({id})

Query Options

$select, $filter, $orderby, $expand, $top, $skip

Request Headers

• Authorization: Bearer {token}
• Content-Type: application/json (POST/PATCH)
• If-Match: {etag} (required for PATCH)

Key Properties (Partial)

• id (SystemId, GUID)
• toChange (boolean)
• lastModifiedDateTime (read‑only)

Refer to $metadata for the full schema.

Notes

• Use the toChange flag to mark a document that should be changed as part of the ECO.
• changeDescription is a media field on the parent ECO; it is accessible via this document using the media route above.

Examples

• Mark a document “to change”: PATCH {Base}/companies({companyId})/engChangeOrderDocuments({docId}) { "toChange": true }

• Update ECO change description via document route: PUT {Base}/companies({companyId})/engChangeOrderDocuments({docId})/engChangeOrder/changeDescription Content-Type: text/plain Updated description via document route

See Also

engChangeOrder
engChangeOrderDrawing
engChangeOrderTask

Feedback
Submit feedback for this page .