engChangeOrder Resource Type

Use the "engChangeOrder" API to manage Engineering Change Orders (ECOs) created from ECNs. Work with tasks, documents, drawings, change description (media), and apply task templates.

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 ECOs.

Methods

Operation	Company‑scoped	Unscoped
List ECOs	GET /companies({companyId})/engChangeOrders	GET /engChangeOrders
Create ECO	POST /companies({companyId})/engChangeOrders	POST /engChangeOrders
Get ECO	GET /companies({companyId})/engChangeOrders({id})	GET /engChangeOrders({id})
Update ECO	PATCH /companies({companyId})/engChangeOrders({id})	PATCH /engChangeOrders({id})
Delete ECO	DELETE /companies({companyId})/engChangeOrders({id})	DELETE /engChangeOrders({id})
Get change description (media)	GET /companies({companyId})/engChangeOrders({id})/changeDescription	GET /engChangeOrders({id})/changeDescription
Update change description (media)	PUT /companies({companyId})/engChangeOrders({id})/changeDescription	PUT /engChangeOrders({id})/changeDescription
Apply task template by code (action)	POST /companies({companyId})/engChangeOrders({id})/Microsoft.NAV.applyTaskTemplateByCode	POST /engChangeOrders({id})/Microsoft.NAV.applyTaskTemplateByCode
Apply task template (action)	POST /companies({companyId})/engChangeOrders({id})/Microsoft.NAV.applyTaskTemplate	POST /engChangeOrders({id})/Microsoft.NAV.applyTaskTemplate

Endpoints

Company‑scoped

GET/POST /companies({companyId})/engChangeOrders
GET/PATCH/DELETE /companies({companyId})/engChangeOrders({id})
GET/PUT /companies({companyId})/engChangeOrders({id})/changeDescription (media)
POST /companies({companyId})/engChangeOrders({id})/Microsoft.NAV.applyTaskTemplateByCode (action)
POST /companies({companyId})/engChangeOrders({id})/Microsoft.NAV.applyTaskTemplate (action)
GET/PATCH/DELETE /companies({companyId})/engChangeOrders({id})/engChangeNotice

Unscoped

GET/POST /engChangeOrders
GET/PATCH/DELETE /engChangeOrders({id})
GET/PUT /engChangeOrders({id})/changeDescription (media)
POST /engChangeOrders({id})/Microsoft.NAV.applyTaskTemplateByCode (action)
POST /engChangeOrders({id})/Microsoft.NAV.applyTaskTemplate (action)
GET/PATCH/DELETE /engChangeOrders({id})/engChangeNotice

Related resources

See also: engChangeOrderDocument, engChangeOrderDrawing, engChangeOrderTask

Related collections

Child endpoints for tasks, documents, and drawings are documented on their respective resource pages.

Query Options

$select, $filter, $orderby, $expand (engChangeOrderTasks,engChangeOrderDocuments,engChangeOrderDrawings,engChangeNotice), $top, $skip

Request Headers

Authorization: Bearer {token}
Content-Type: application/json (POST/PATCH); text/html (PUT changeDescription)
If-Match: {etag} (required for PATCH)

Key Properties (Short)

id (SystemId), number, status
itemNumber, itemDescription (read‑only)
changeReasonCode, changeReasonDescription (read‑only)
engChangeNoticeNumber
drawingNumber, drawingTypeCode
drawingReleaseBlocked, allTasksCompleted, numberOfDocumentsToChange (read‑only)
creationDate, createdBy, lastModifiedDateTime (read‑only)

Examples

List with details: GET {Base}/companies({companyId})/engChangeOrders?$expand=engChangeOrderTasks,engChangeOrderDocuments,engChangeOrderDrawings
Update change description: PUT {Base}/companies({companyId})/engChangeOrders({id})/changeDescription Content-Type: text/html Updated description (HTML allowed)
Apply template by code: POST {Base}/companies({companyId})/engChangeOrders({id})/Microsoft.NAV.applyTaskTemplateByCode { "engTaskTemplateCode": "TMPL001" }