NextGen APIs

GET /scheduling/r1/schedule-work

Http Verb

GET

Url

/scheduling/r1/schedule-work

Permissions required


Personally Identifiable Information (PII)

No

Sensitive Information

No

Last Modified Version

r1

Released since

2024 W2 (FSM 18.0)

Deprecated since


Removed since


Tech Tags

PAGINATION ORDERING-SERVER-SIDE

Business Logic

This API returns a list of Schedulings filtered by input criteria.

If this API is called without any filter the amount of data extracted can be very large, so there is a limitation on the number of record that can be extracted to 1000 elements.

Query String Parameters

Filter ℹ️

Field

Validations

Note

id


Collection of ids

workShiftId


Collection of ids

interventionId


Collection of ids

statusId


Collection of ids

arrivalDate



startDate



endDate



order



workOrderOperationId


Collection of ids

Page ℹ️

Default.

Fields ℹ️

Default.

Language ℹ️

Default.

Header Parameters

Default.

Response documentation

Response payload fields

Field

Note

id


workShiftId


interventionId


statusId


arrivalDate


startDate


endDate


distanceFromPrevious


timeFromPrevious


distanceToNext


timeToNext


order


duration


workOrderOperationId


breakTime


Response error codes