NextGen APIs

POST /work-orders/bundler/r1/bundlings

Http Verb

POST

Url

/work-orders/bundler/r1/bundlings

Permissions required


Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2025 W3 (FSM 21.0)

Deprecated since


Removed since


Tech Tags


Business Logic

This API manages the creation of bundles by applying specific bundling rules through a comprehensive multi-phase workflow.

Input Parameters

  • Work Order Operation IDs (required): a collection of work order operation IDs to be bundled

  • Bundle Name (optional): if multiple bundles are created from the same rule, each will be named using the given name with an auto-incremented suffix (example: MyBundle-1, MyBundle-2, etc.).
    If no name is provided, the system generates a default name combining:

    • Execution type prefix

    • Rule identifier (if present)

    • Timestamp

    Example: MANUAL_RULE241_20250728153352803

  • Bundling Rule ID (optional): defines the criteria and constraints used during the bundling process.

Bundling Workflow Phases

  1. Selection & Validation

    • Selects eligible work order operations from the input set

    • Validates their status and checks bundling prerequisites

  2. Grouping & Coordination

    • Groups compatible operations based on the selected bundling rules

  3. Bundle Creation

    • Creates new bundles from grouped operations

    • Returns the list of newly created Bundle IDs.


Header Parameters

Default.

Request Body Parameters

Field

Validations

Note

workOrderOperations

Mandatory


bundleName

Max length: 50


bundlingRule

Referenced resource id existance check

 


Response documentation

Response payload fields

Field

Note

Example value

payload

 List of ids of created bundles

[
  {
    "id": 1
  }
]

Response error codes

NOT_FOUND, BASE_005, BASE_0008, BUNDLERS_0009, BUNDLERS_0013, BUNDLERS_0026, BUNDLERS_0032