NextGen APIs

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


Http Verb

GET

Url

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

Permissions required

FSM_DATACOLLECTION_CONFIGURATION_VIEW

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

PAGINATION, ORDERING-SERVER-SIDE

Business Logic

This API returns a list of data collection template work order creation rules filtered by input criteria. These rules define which dynamic forms templates should be automatically associated with work orders based on the work cycle operation.

Query String Parameters

Filter ℹ️

Field

Validations

Notes

id


Collection of rule IDs

templateId


Collection of template IDs to filter rules by associated template

workCycleOperationId


Collection of work cycle operation IDs to filter rules by operation

active


Boolean filter for active status

Order ℹ️

Default Order

default

Possible order values

No other ordering options available.

Page ℹ️

Default.

Fields ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Notes

id

Work order creation rule ID

templateId

ID of the associated dynamic forms template

workCycleOperationId

ID of the work cycle operation that triggers this rule

active

Boolean indicating if the rule is active

JSON
{
  "content": [
    {
      "id": 1,
      "templateId": 100,
      "workCycleOperationId": 50,
      "active": true
    }
  ],
  "page": {
    "number": 0,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1
  }
}

Response error codes

BASE_0001 ,DATACOLLECTION_0027