NextGen APIs

POST /documents/dynamic-forms/r1/wo-creation-rules


Http Verb

POST

Url

/documents/dynamic-forms/r1/wo-creation-rules

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 creates a new data collection template work order creation rule. The rule defines that when a work order with the specified work cycle operation is created, the associated dynamic forms template should be automatically linked to it.

Validation Rules

  • templateId: Required. The template must exist in the system.

  • workCycleOperationId: Required. The work cycle operation must exist in the system.

  • active: Optional. Defaults to true if not provided.

  • Uniqueness: A rule with the same templateId and workCycleOperationId combination must not already exist.

Header Parameters

Default.

Request Body

Request payload fields

Field

Type

Required

Default

Notes

templateId

Long

Yes


ID of the dynamic forms template to associate

workCycleOperationId

Long

Yes


ID of the work cycle operation that triggers the rule

active

Boolean

No

true

Whether the rule is active

JSON
{
  "templateId": 100,
  "workCycleOperationId": 50,
  "active": true
}

Response documentation

Response payload fields

Field

Notes

id

The ID of the newly created work order creation rule

Response Headers

Header

Description

Location

URL of the newly created resource

JSON
{
  "id": 1
}

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