Table of Contents

engChangeOrderTask Resource Type

Use the "engChangeOrderTask" API to manage tasks on an ECO and access the ECO change description media via task routes.

Permissions

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

Methods

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

Endpoints

Company‑scoped

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

Unscoped

  • GET/POST /engChangeOrderTasks
  • GET/PATCH/DELETE /engChangeOrderTasks({id})
  • GET/PATCH/DELETE /engChangeOrderTasks({id})/engChangeOrder
  • GET/PUT /engChangeOrderTasks({id})/engChangeOrder/changeDescription (media)
  • via ECO navigation:
    • GET/POST /engChangeOrders({ecoId})/engChangeOrderTasks
    • GET/PATCH/DELETE /engChangeOrders({ecoId})/engChangeOrderTasks({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)
  • status (enum)
  • subEngChangeOrderNo
  • lastModifiedDateTime (read‑only)
  • assignedTo
  • processedBy
  • assignedEmail (derived)

Refer to $metadata for the full schema.

Notes

  • Task templates can be applied on ECO via actions documented in the engChangeOrder resource page.
  • changeDescription is a media field on the parent ECO; it is accessible via this task using the media route above.
  • subEngChangeOrderNo links the task to a sub engineering change order and can be used for hierarchical planning.
  • workCenterGroupCode and subEngChangeOrderNo are mutually exclusive for a task line.
  • assignedEmail resolution order: User Setup E-Mail → User Contact Email → Work Center Group "CCS PDM E‑Mail" → empty.
  • When a sub order is linked via subEngChangeOrderNo, deleting the task also deletes the linked sub order. Use this with caution in API workflows.
  • Circular references between orders are blocked by validation. An error is returned if the referenced sub order is already part of the same order tree.

External Business Event

This resource raises an external business event when a task becomes activated.

  • Event name: EngChangeOrderTaskActivated
  • Event caption: Eng. Change Order Task is activated
  • Event description: Triggered when Eng. Change Order Task is activated
  • Event category: CCS PDM Eng. Change Order
  • Payload: engChangeOrderTaskId (Guid) – the SystemId of the activated task

When it fires

  • Bulk activation when an ECO is set to Released (all successor tasks with status Not Started and no unmet predecessors)
  • On completion of a task (activates direct successors that now have all predecessors completed)

Discover the event definition

  • GET {Base}/externalbusinesseventdefinitions(appId={appId},name='EngChangeOrderTaskActivated',eventVersion={eventVersion})

Subscribe to the event (webhook)

  • POST {Base}/externaleventsubscriptions Content-Type: application/json { "...": "Provide event reference and destination per your webhook handler" }

List subscriptions

  • GET {Base}/externaleventsubscriptions

Examples

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

See Also

engChangeOrder
engChangeOrderDocument
[engChangeOrderDrawing](./engChangeOrderDrawing.md
) Event: EngChangeOrderTaskActivated


Feedback
Submit feedback for this page .

Edit this page