NextGen APIs

PATCH /documents/dynamic-forms/r1/wo-creation-rules/{woCreationRuleId}


Http Verb

PATCH

Url

/documents/dynamic-forms/r1/wo-creation-rules/{woCreationRuleId}

Permissions required

FSM_DATACOLLECTION_CONFIGURATION_EDIT

Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2026 W1 (FSM 22.0)

Deprecated since


Removed since


Tech Tags


Http Verb

PATCH

Url

/documents/dynamic-forms/r1/wo-creation-rules/{woCreationRuleId}

Permissions required

FSM_DATACOLLECTION_CONFIGURATION_EDIT

Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2026 W1 (FSM 22.0)

Deprecated since


Removed since


Tech Tags


Business Logic

This API updates an existing data collection template work order creation rule. All fields are optional and only provided fields will be updated.

Validation Rules

  • templateId: If provided, the template must exist in the system.

  • workCycleOperationId: If provided, the work cycle operation must exist in the system.

  • active: If provided, must not be null.

  • Uniqueness: If templateId or workCycleOperationId are updated, the new combination must not conflict with existing rules (except for the rule being updated itself).

Path Parameters

Parameter

Type

Required

Description

woCreationRuleId

Long

Yes

The ID of the work order creation rule to update

Header Parameters

Default.

Request Body

Request payload fields

Field

Type

Required

Notes

templateId

Long

No

ID of the dynamic forms template to associate

workCycleOperationId

Long

No

ID of the work cycle operation that triggers the rule

active

Boolean

No

Whether the rule is active

JSON
{
  "templateId": 101,
  "workCycleOperationId": 51,
  "active": false
}

Response documentation

Response

HTTP 204 No Content - The rule was successfully updated.

Response error codes

BASE_0001 ,BASE_0020 | NOT_FOUND ,DATACOLLECTION_0027, BASE_0006 , BASE_0007 , BASE_0010 ,PROPERTY_REQUIRED | BASE_0003 , DUPLICATE_ENTRY |DATACOLLECTION_0001