NextGen APIs

PATCH /work-orders/bundler/r1/bundling-rules/{ruleId}

Http Verb

PATCH

Url

PATCH /work-orders/bundler/r1/bundling-rules/{ruleId}

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 updates an existing bundling rule.

The validations are:

  • At least one between automaticExecution or manualExecution must be set

  • If active flag is not specified, then true is the default value

  • If the new rule is set as “default”, checks if another one is already present on the system and return an error if its already present

  • Checks if minBundleSize and maxBundleSize are valid values

    • max greater than min

    • positive min

    • positive max

    • max lower than default DEFAULT_MAX_BUNDLE_SIZE (100)

  • Checks if priority is unique, otherwise returns an error

  • Checks if rule code is unique, otherwise returns an error

  • If manual execution is not selected, checks if a primary criterion is enabled

Returns the ID of the created bundling rule.

Path Parameters

Field

ruleId

Header Parameters

Default.

Request Body Parameters

Field

Notes

code


description


priority


active


manualExecution


automaticExecution


minBundleSize


maxBundleSize


maxBundleDuration


technicalObjectBundlingType


locationBundlingType


bundlingByRequestType


bundlingByServiceType


bundlingByTechnicalObjectType


bundlingByOperationType


bundlingByTeamCardinality


timeIntervalBundlingType


isDefault


Response documentation

Response error codes

NOT_FOUND, BASE_0001, BASE_0006, BASE_0007, BASE_0010, BUNDLERS_0017, BUNDLERS_0024, BUNDLERS_0031, BUNDLERS_0042