NextGen APIs

GET /work-orders/r1/workload-distributions


Http Verb

GET

Url

/work-orders/r1/workload-distributions

Permissions required

WorkOrder: View (fsm.core.workorder.view)

or

WorkOrder: Edit (fsm.core.workorder.edit)

Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2025 W1 (FSM 18.0)

Deprecated since

 

Removed since

 

Tech Tags

PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns the total duration of Work Orders aggregated by start date / end date and activity, with the sum of the duration of the work orders in the interval.


BL:

Retrieve records from Work Orders and related Operations, filtering for WO startDate and endDate.

Group by activity, startDate, endDate.

Return the data.

Query String Parameters

Filter ℹ️

Field

Validations

Note

workOrderStartDate

Format: ISO-8601


workOrderEndDate

Format: ISO-8601


workOrderEnterDate

Format: ISO-8601


workOrderOperationCenterId


Collection of Ids

workOrderWorkCenterId


Collection of Ids

workOrderStatusId


 Collection of Ids

workOrderOperationStatusId


 Collection of Ids

workOrderOperationTypeId


Collection of Ids

workOrderFacilityTypeId


Collection of Ids

workOrderOperationActivityId


Collection of Ids

workOrderUrgencyId


 Collection of Ids

workOrderRequestTypeId


 Collection of Ids

workOrderServiceTypeId


Collection of Ids

workOrderOriginId


Collection of Ids

workloadDistributionType


Possible values:
“SCHEDULABLE”, “CLOSED”

Order ℹ️

Default Order

activity (ASC, DESC)

Possible order values

startDate (ASC, DESC)

Page ℹ️

Default.

Fields ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

activity

 

startDate

 

endDate

 

duration

 

tasks


Response error codes

BASE_0001